package com.javadaemon.rpgengine.util;

import java.util.HashMap;
import java.util.Map;

import com.javadaemon.rpgengine.model.DIRECTION;
import com.javadaemon.rpgengine.util.ResourceManager.ANIMATION;


/*
	Copyright (c) 2011, Morten Andersen
	All rights reserved.

	Redistribution and use in source and binary forms, with or without
	modification, are permitted provided that the following conditions are met:
	* Redistributions of source code must retain the above copyright
	notice, this list of conditions and the following disclaimer.
	* Redistributions in binary form must reproduce the above copyright
	notice, this list of conditions and the following disclaimer in the
	documentation and/or other materials provided with the distribution.
	* The name of the author may not be used to endorse or promote products
	derived from this software without specific prior written permission.

	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
	ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
	WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	DISCLAIMED. IN NO EVENT SHALL MORTEN ANDERSEN BE LIABLE FOR ANY
	DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
	(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
	LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
	SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

/**
 * An animation set instance is used for linking related animations together in a single group.
 * The animation set contains all movement direction animations applicable for a single entity,
 * and contains a lookup method for getting the animation for moving in a specific direction. 
 * 
 * @author Somnium
 *
 */
public class AnimationSet {
	private Map<DIRECTION, ANIMATION> animations; // The reference keys for animations contained in this animation set. 
	
	public AnimationSet()
	{
		animations = new HashMap<DIRECTION, ANIMATION>();
	}
	
	/**
	 * Gets the animation reference key for the movement animation applicable for the given direction.
	 * @param direction
	 * @return
	 */
	public ANIMATION getAnimation(DIRECTION direction)
	{
		return animations.get(direction);
	}
	
	/**
	 * Sets the animation reference key for the animation to be displayed when moving in the given direction.
	 * @param direction
	 * @param animation
	 */
	public void putAnimation(DIRECTION direction, ANIMATION animation)
	{
		animations.put(direction, animation);
	}
}
